Using the Analyzer output
Given the options, the Analyzer produces five types of hyperlinked HTML documents in your current working directory as described in the following sections. All of these documents are hyperlinked from a starting index.html file generated in the target-directory:
Index document
This document is the starting index.html file that the Analyzer generates to describe the WSDL file. Figure 8–1 shows an example of this document.
If the WSDL file defines more than one service, as in this example, the index document becomes a service index document that lists all defined services as hyperlinks, each to its own service document containing sections that describe the service.
This list appears after all other sections that describe the WSDL file, as shown in Table 8–1.
This index document also contains a hyperlink to an operation index document that contains an alphabetical list of all operations from all port types in all services (see the "Operation index document" section).
If the WSDL file defines only one service, the index document redirects the browser to that single service document, as shown in Table 8–4.
Operation index document
The operation index document contains a hyperlinked alphabetical list of all operations from all port types in all services defined in the WSDL file. Figure 8–2 shows an example of this document.
The list is in the form of a table with columns describing the port type and service information for each operation, as shown in Table 8–2.
The operation index document also contains a hyperlink to the service index (see the "Index document" section) and data types document (see the "Data types document" section).
Service document
The service document is an HTML document that provides an overview of a Web service interface. Figure 8–3 shows an example of a service document for one of the services described in a WSDL with multiple services.
Table 8–3 lists and describes the sections of a service document if the WSDL contains multiple services, as in Figure 8–3.
A service document for one of multiple services also contains a hyperlink to the service index (see the "Index document" section) and data types document (see the "Data types document" section).
Figure 8–4 shows an example of a service document for a WSDL containing only one service.
Table 8–4 lists and describes the sections of the service document if the WSDL contains only a single service, as in Figure 8–4.
This single service document also contains a hyperlink to an operation index document that contains an alphabetical list of all operations from all port types in the service (see the "Operation index document" section).
Port type document
For each port type defined in the WSDL file, the Analyzer generates a separate HTML port type document that contains detailed information on how to work with that port type. Figure 8–5 shows an example of the beginning of a port type document.
Table 8–5 lists and describes the sections that the beginning of a port type document contains.
A port type document for a WSDL with a single service also contains a hyperlink to the single service document ( "Service document" section), data types document ( "Data types document" section), and operation index document ( "Operation index document" section). A port type document for a WSDL with multiple services adds a link to the service index ( "Index document" section), as shown in Table 8–5.
Figure 8–6 shows an example of the connection parameters from the Connection details section of a port type document, as described in Table 8–6.
Figure 8–7 shows an example of service and port descriptions from the Connection details section of a port type document.
The WSDL Analyzer can also list the WSDL bindings that support the port type. For more information on how the Analyzer describes services, ports, and bindings, see Table 8–6.
Figure 8–8 shows a connection code example from the Connection details section of a port type document, as described in Table 8–6.
Table 8–6 lists and describes the Connection details section of a port type document.
Figure 8–9 shows an example of how the Analyzer starts describing a Web service operation in the “Operation (internal procedure) detail” section of a port type document.
Figure 8–10 shows an example of how the Analyzer finishes describing a Web service operation in the “Operation (internal procedure) detail” section of a port type document, describing parameters, return values, headers, and faults associated with the operation as described in Table 8–7.
Table 8–7 lists and describes the “Operation (internal procedure) detail” section of a port type document.
The WSDL Analyzer maps all Web service operations from a port type to a 4GL internal procedure prototype. This allows all Web service operations to be invoked either synchronously or asynchronously as you require. For some Web service operations, the Analyzer also indicates a mapping to a 4GL user-defined function prototype. For these dual-mapping operations:
- The Analyzer describes both the internal procedure mapping and the user-defined function mapping in the port type document.
- You can invoke them either as 4GL procedures or user-defined functions, depending on your requirements at any given point in your application. However, as with user-defined functions in the native 4GL, you cannot invoke these Web service operations as functions asynchronously.
Figure 8–9 and Figure 8–10 show most of an example description for a dual-mapping Web service operation in the “Operation (internal procedure) detail” section of a port type document.
The port type document also describes how the Analyzer maps any complex data to Progress 4GL temp-tables or ProDataSets. For more information, see the "Analyzing complex data" section.
Data types document
For all the complex types defined in the WSDL file, the Analyzer generates a single HTML data types document that contains a summary and detailed information on each complex type, whether or not they are actually used in the Web service. Figure 8–11 shows an example of the data type summary list that begins this document, and Figure 8–12 shows an example data type detail in this document.
Table 8–8 lists and describes the sections that the data types document contains.
Note: This document does not describe standard XML Schema types. For information on how the Analyzer maps XML Schema types to Progress 4GL data types, see the "Mapping XML Schema data types to Progress 4GL data types" section. It also does not indicate what complex data types are mapped to temp-tables or ProDataSets. When the Analyzer identifies a complex type that maps to a temp-table or ProDataSet, it documents the 4GL object and an example of its SOAP representation for the appropriate parameter, SOAP header entry, or SOAP fault detail in the port type document (see the "Port type document" section). For more information on how the Analyzer maps and documents temp-table and ProDataSet representations of complex types, see the "Analyzing complex data" section.
A data types document for a WSDL also contains a hyperlink to the current service document (see the "Service document" section) and to the operation index document (see the "Operation index document" section). It also provides a hyperlink to the beginning (top) of the document from the detail for any data type entry.